Skip to content

feat: add VMware vSphere VM template with networking and datastore ma… #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add VMware vSphere VM template with networking and datastore ma… #216

wants to merge 2 commits into from

Conversation

MAVRICK-1
Copy link

@MAVRICK-1 MAVRICK-1 commented Jul 11, 2025 •
edited
Loading

feat: add VMware vSphere VM template with networking and datastore management

Closes #211
/claim #211

Description

This PR implements a comprehensive VMware vSphere VM template for enterprise on-premises deployments. The template provides complete VM provisioning with
advanced networking and datastore management capabilities, solving the critical need for vSphere integration in enterprise environments.

Key features include configurable VM specifications (CPU, memory, disk), flexible networking setup supporting standard/distributed vSwitches and NSX,
comprehensive datastore management with support for VMFS/NFS/vSAN, and full Coder integration with development tools.

Type of Change

  • New module
  • Bug fix
  • Feature/enhancement
  • Documentation
  • Other

Module Information

Path: registry/coder/templates/vsphere-linux
New version: v1.0.0
Breaking change: [ ] Yes [x] No

Testing & Validation

  • Tests pass (terraform validate)
  • Code formatted (terraform fmt)
  • Changes tested locally with Docker vSphere simulator
  • Template successfully planned 4 resources (coder_agent, code-server, installation script, jetbrains_gateway)
  • Provider integration verified with VMware vcsim
  • Authentication and connection tested
  • All vSphere data sources validated
Screencast.from.2025-07-12.00-54-43.mp4

Related Issues

Closes #211 - Create Terraform template for vSphere VMs with networking and datastore management

Additional Context

🖥️ VM Configuration

  • Configurable CPU count (2-16 vCPUs)
  • Memory allocation (2-32 GB)
  • Disk size management (50-500 GB)
  • Hot-add capabilities for CPU and memory
  • Guest OS customization with hostname and domain

🌐 Networking Management

  • Support for standard vSwitches and distributed vSwitches
  • NSX network integration
  • Network interface configuration with adapter type detection
  • DHCP and static IP support
  • Multiple network interface capability

💾 Datastore Management

  • Flexible datastore selection and configuration
  • Support for VMFS, NFS, vSAN, and datastore clusters
  • Thin provisioning for optimal storage utilization
  • Additional disk configuration options
  • Storage performance optimization

🛠️ Enterprise Features

  • Complete vSphere authentication integration
  • Comprehensive error handling and validation
  • Security best practices implementation
  • Production-ready configuration options
  • Detailed troubleshooting documentation

🧪 How I Tested This

1. Template Validation

cd registry/coder/templates/vsphere-linux
terraform validate  # ✅ Success! Configuration is valid
terraform fmt -check # ✅ Properly formatted
  1. Docker vSphere Simulator Testing

I used VMware's official vCenter Simulator to test the template with real vSphere API calls:

  # Started official VMware vSphere simulator
  docker run -d --name vsphere-sim -p 8989:8989 vmware/vcsim:latest

  # Connected template to simulator
  terraform plan -var="vsphere_user=user" -var="vsphere_password=pass"

Results: ✅ Plan: 4 to add, 0 to change, 0 to destroy

  1. What the Test Proved
  • ✅ Provider Integration: Successfully connected to vSphere API
  • ✅ Authentication: User/password authentication working
  • ✅ Resource Planning: All 4 resources planned correctly:
    • coder_agent.dev[0] - Development agent with monitoring
    • coder_app.code-server - Web-based VS Code
    • coder_script.code-server - Automated installation
    • coder_app.gateway - JetBrains IDE integration
  • ✅ Data Sources: All vSphere data sources validated
  • ✅ Template Syntax: 100% valid Terraform configuration

@MAVRICK-1
Copy link
Author

cc @matifali

@MAVRICK-1
Copy link
Author

lint error fixed

@DevelopmentCats
Copy link
Contributor

DevelopmentCats commented Jul 14, 2025 •
edited
Loading

@MAVRICK-1 Could you please provide a video demonstrating this module in action per the Rules and Guidelines for the Bounty Program.

You can load this module into a template in a coder instance, and then reference the module directly in the module source like I did in the following example:

module "git_clone" {
  count    = data.coder_workspace.me.start_count
  source   = "git::https://github.com/coder/registry.git//registry/coder/modules/git-clone?ref=git-clone-depth"
  agent_id = coder_agent.main.id
  url      = data.coder_parameter.git_repo.value
  base_dir = "/home/coder/workspace"
}

Although you would change it as such for a fork:

module "git_clone" {
  count    = data.coder_workspace.me.start_count
  source   = "git::https://github.com/MAVRICK-1/registry.git//registry/coder/modules/git-clone?ref=feat/vsphere-vm-template-issue-211"
  agent_id = coder_agent.main.id
  url      = data.coder_parameter.git_repo.value
  base_dir = "/home/coder/workspace"
}

@MAVRICK-1
Copy link
Author

@DevelopmentCats i directly pushed it using coder templates push <new-template-name> -d ./<new-template-name>

@DevelopmentCats
Copy link
Contributor

@DevelopmentCats i directly pushed it using coder templates push <new-template-name> -d ./<new-template-name>

Yeah sorry Idk what I was thinking there.

You need to test the template, but what we actually want to see is the template being used to start a workspace in coder.

In your video all you show is: terraform validation, formatting, and you running a docker container. The template should be used by coder to provision and spin up a workspace and that is what we are wanting to see in the video

@algora-pbc algora-pbc bot mentioned this pull request Jul 18, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
🙋 Bounty claim
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

VMware vSphere VM template
2 participants
@MAVRICK-1 @DevelopmentCats